Skip to content

split into usable functions and added docstrings for base32 cipher #5466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Oct 22, 2021
Merged

split into usable functions and added docstrings for base32 cipher #5466

merged 3 commits into from
Oct 22, 2021

Conversation

QuartzAl
Copy link
Contributor

@QuartzAl QuartzAl commented Oct 20, 2021 •
edited
Loading

Describe your change:

  • Separated algorithm in ciphers/base32.py to 2 usable functions: one for encoding, one for decoding. Also added in docstrings along with the functions.
  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

@ghost ghost added awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files labels Oct 20, 2021
@QuartzAl QuartzAl changed the title split into usable functions and added docstrings split into usable functions and added docstrings for base32 cipher Oct 20, 2021
cclauss
cclauss reviewed Oct 20, 2021
View reviewed changes
cclauss
cclauss reviewed Oct 20, 2021
View reviewed changes
QuartzAl and others added 2 commits October 20, 2021 21:10
@QuartzAl @cclauss
Simplified code
fcd6d55 
Co-authored-by: Christian Clauss <[email protected]>
@QuartzAl @cclauss
Simplified code
6830795 
Co-authored-by: Christian Clauss <[email protected]>
@QuartzAl QuartzAl requested a review from cclauss October 20, 2021 14:11
@QuartzAl
Copy link
Contributor Author

@cclauss is there anything wrong? when can this PR be accepted?

@ghost ghost removed the awaiting reviews This PR is ready to be reviewed label Oct 22, 2021
@cclauss cclauss merged commit d82cf52 into TheAlgorithms:master Oct 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss cclauss approved these changes

Assignees
No one assigned
Labels
enhancement This PR modified some existing files
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@QuartzAl @cclauss